TWL Picture Format Checker
Version 2.1.0
Copyright  Nintendo of America Inc. 2009, 2010
Readme


-------------------------------------------------
1. Introduction
2. Operating Environment Requirements
3. How To Use
 a. Obtaining Save Data
 b. Windows Application
 c. Command Line Application
4. What the Program Does
5. What the Program Does Not Do
6. Upgrading From Previous Revisions
7. Notes
8. Revision History
-------------------------------------------------


-------------------------------------------------
1. Introduction
TWL Picture Format Checker is a tool to help determine if there is an image saved in game save data. The tool can detect a few common formats, including BMP, JPEG, and PNG. To perform its check, the tool crawls through the game save data a byte at a time, looking for valid images. If a valid image is found, it can be displayed on the screen and some basic information on the save data and individual image can also be shown.
-------------------------------------------------


-------------------------------------------------
2. Operating Environment Requirements
Windows XP SP3
.NET Framework 2.0
-------------------------------------------------


-------------------------------------------------
3. How To Use

----
a. Obtaining Save Data
This tool can check save data for either Card or NAND applications.

Card application save data can be obtained by using the IS Debugger software to get pull the backup memory off of the backup memory and place it as a file on the hard drive.

NAND application save data can be obtained by using the NandFiler app on a Panda unit. This will allow for the file to be exported to an SD card. The TWL Picture Format Checker tool can read this save data off of the SD card, or the data can be copied to the computer hard drive and be read from there.

Note: For NAND applications we recommend using the Backup in NandFiler to extract save data as it provides the easiest and most robust check.
----

----
b. Windows Application
To start the application, locate TWLPictureFormatChecker.exe and run the application.

There are two ways to open files, either select Open from the Menu Bar or drag-and-drop the files into the running application - this will begin the loading process. Any type of file can be dropped into the application, so file extensions do not matter.

After the file is loaded, the white box on the left side of the screen will contain a list of opened files. If there are any alerts for a loaded file, the filename will be listed in red. Clicking on that file will show the alerts and general notifications in right side of the window. General notifications include offset and format data for each image found (offset: type). Images will also be listed as sub-items under the filename with the file's type after the image number. An example of an entry in the list is: 
	Image 0 (JPEG)

To look through the images, expand a file by double-clicking the filename or by clicking the '+' icon next to the filename. Then select the image of interest. As an image is selected, the image will show on the right half of the screen. If there were any image details embedded along with the image then this information will be displayed in the white box at the bottom of the screen.
----

----
c. Command Line Application
To start the application, run twl_picfmtchecker.exe. Save data files should be provided as arguments. Not providing an argument will result in usage and version information being output.

As each image is loaded, its information will be output to the screen. For each file, there will be at least 2 lines of output. The first will be the filename of the file being processed. Second is the number of images that were found in the save data. Subsequent lines are notifications. These notifications are either general alerts or information on an image that was found (offset: type).

Example:
twl_picfmtchecker.exe file.bin
==================================================
Parsing file file.bin
3 images found
Multiple image types are in use
0x97    : JPEG image found
0x4FB2  : BMP image found
0x10FE8 : JPEG image found
==================================================----

-------------------------------------------------


-------------------------------------------------
4. What the Program Does
This application is used to look through game save data for images. Images of the formats BMP, JPEG, PNG, GIF, and TIFF can be found by this tool.
-------------------------------------------------


-------------------------------------------------
5. What the Program Does Not Do
This program does not find images that are not saved in the formats listed in section 4. This is the only realistic form this application can take as raw image data mixed with non-image data is indistinguishable at a low-level.
-------------------------------------------------


-------------------------------------------------
6. Upgrading From Previous Versions
Version 2.0 (and later) of this software is meant as a replacement for previous versions of the software. Attempting to run a previous version of the software after running the latest version (example: running version 1.1 after running 2.0) may result in the application crashing.
-------------------------------------------------


-------------------------------------------------
7. Notes
If you do encounter any problems with the software, please contact SDSG at support@noa.com.
-------------------------------------------------


-------------------------------------------------
8. Revision History

2.1.0
 - Updated messaging output

2.0.2
 - Added operating system requirements to readme.
 - Fixed issue where some data was incorrectly identified as a JPEG file.
 - Fixed issue where file list could become desynchronized from loaded files.
 - Fixed a memory leak.

2.0.1
 - Improved speed of the GUI image parsing.

2.0
 - Allowed for multiple files to be opened at the same time.
 - Redesigned UI to accommodate multiple files be opened.
 - Added TWL to tool name
 - Fixed a crash bug with certain JPEG files.

1.1
 - Changed how settings were saved.
 - Resolved crash bugs in Japanese OS versions.

1.0
 - Initial release.

-------------------------------------------------
